Communication Biz API
POST communicationMessage
This resource can be used to create CommunicationMessage.
URL
For on-prem:
https://[localhost]:[port]/communication-biz/v1/{businessId}/communicationmessage/sendFor cloud:
https://esb-cloud-dev.lla.com/dev/communication-biz/tmf-api/communicationManagement/v4/{businessId}/communicationmessage/sendURL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. | Y |
Security Headers
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
Header
| name | value | description | required |
|---|---|---|---|
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
| channeId | string | Channel to business: Can be one of: "agentportal", "ecom", "mobile","selfportal" | N |
Query Param
| name | type | description | required |
|---|---|---|---|
| notificationType | string | Business notification type. Example: "PLACE_ORDER_ENG" | Y N for emarsys |
EMARSYS Data Model:
Note: Use cloudhub url
Applicable for PR, JM, KY, CR, PA, and all Flow markets
| Field Name | M/O | Notes |
|---|---|---|
| messageType (new on TMF681 userGuide 4.0.1) | M | The type of message, such as: SMS, Email, Mobile app push notification. |
| templateId | M | Define the type of the template. |
| characteristic | O | The values of parameters which are used in the content if the content contains them |
| characteristic.name | M | Content parameter identifier |
| characteristic.valueType | O | Data type of the value of the characteristic |
| characteristic.value | M | Content parameter value |
| attachment.name | O | The name of the file NOTE: For Emarsys will support for mentioned Formats → .doc, .docx, .pdf, .rtf, .csv, .xml, .xlsx, .xls, .txt |
| attachment.content (new on TMF681 userGuide 4.0.1) | O | The actual contents of the attachment object, if embedded, encoded as base64. NOTE: For Emarsys will support for mentioned Formats → .doc, .docx, .pdf, .rtf, .csv, .xml, .xlsx, .xls, .txt |
| receiver | N | Receivers of the communication message. |
| receiver.email | M | Receiver address of email, if the communication type is email |
BS Market Data Model:
Note: Use on-prem url
| Field Name | M/O | Notes |
|---|---|---|
| subject | M | The subject of Notification For C2C_AGENT: Order Placed - Form Submission For C2C_CUSTOMER: It’s official! Your BTC order has been placed |
| receiver.email | M | The recipients email address |
| sender.email | M | Senders email address |
| messageType | M | "Email" is in scope |
| characteristic | M | Is the array object with name value pairs. |
| "name": "EXISTING_CUSTOMER", "value": "YES" | O | O for notificationType=C2C AGENT |
| "name": "ACCOUNT_NUMBER", "value": "12345" | O | O for notificationType= C2C AGENT |
| "name": "FIRST_NAME", "value": "FNAME" | O | O for notificationType=C2C CUSTOMER/C2C AGENT |
| name": "LAST_NAME", "value": "LNAME" | O | O for notificationType=C2C CUSTOMER/C2C AGENT |
| "name": "PHONE_NUMBER", "value": "Surname" | O | O for notificationType=C2C CUSTOMER/C2C AGENT |
| "name": "EMAIL", "value": "fname.lname@gmail.com" | O | O for notificationType=C2C CUSTOMER/C2C AGENT |
| "name": "ORDER_DATE", "value": "28/08/2020" | O | O for notificationType=C2C CUSTOMER/C2C AGENT |
| "name": "LEAD_TYPE", "value": "New" | O | O for notificationType= C2C AGENT |
| "name": "PRODUCT_NAME1", "value": "SETUP BOX" | O At least one PRODUCT_NAME is Mandatory, there can be up to 10 PRODUCT_NAME (i.e.,PRODUCT_NAME2,PRODUCT_NAME3) | O for notificationType=C2C CUSTOMER/C2C AGENT |
| "name": "QTY1", "value": "2" | O At least one QTY is Mandatory, there can be up to 10 QTY( i.e.,QTY2,QTY3) | O for notificationType=C2C CUSTOMER/C2C AGENT |
| "name": "PRODUCT_AMOUNT1", "value": "$12" | O At least one PRODUCT_AMOUNT is Mandatory, there can be up to 10 PRODUCT_AMOUNT(i.e.,PRODUCT_AMOUNT2,PRODUCT_AMOUNT3) | O for notificationType=C2C CUSTOMER/C2C AGENT |
| "name": "AMOUNT", "value": "$12" | O | O for notificationType=C2C CUSTOMER/C2C AGENT |
Refer examples C2C_Agent-BS and C2C_Customer-BS under POST communicationMessage/send
KY Market Data Model:
Note: Use on-prem url
| Field Name | M/O | Notes |
|---|---|---|
| subject | M | The subject of Notification For C2C_AGENT: It’s official! Your Flow order has been placed For C2C_CUSTOMER: Congratulations! Thank you for your order! |
| receiver.email | M | The recipients email address |
| sender.email | M | Senders email address |
| messageType | M | "Email" is in scope |
| characteristic | O | Is the array object with name value pairs. |
| "name": "EXISTING_CUSTOMER", "value": "YES" | O | O for notificationType=C2C AGENT |
| "name": "ACCOUNT_NUMBER", "value": "12345" | O | O for notificationType= C2C AGENT |
| "name": "FIRST_NAME", "value": "FNAME" | O | O for notificationType=C2C CUSTOMER/C2C AGENT |
| name": "LAST_NAME", "value": "LNAME" | O | O for notificationType=C2C CUSTOMER/C2C AGENT |
| "name": "PHONE_NUMBER", "value": "Surname" | O | O for notificationType=C2C CUSTOMER/C2C AGENT |
| "name": "EMAIL", "value": "fname.lname@gmail.com" | O | O for notificationType=C2C CUSTOMER/C2C AGENT |
| "name": "ORDER_DATE", "value": "28/08/2020" | O | O for notificationType=C2C CUSTOMER/C2C AGENT |
| "name": "LEAD_TYPE", "value": "New" | O | O for notificationType= C2C AGENT |
| "name": "PRODUCT_NAME1", "value": "SETUP BOX" | O There can be up 1 to 10 PRODUCT_NAME (i.e.,PRODUCT_NAME2,PRODUCT_NAME3) | O for notificationType=C2C CUSTOMER/C2C AGENT |
| "name": "QTY1", "value": "2" | O There can be up 1 to 10 QTY( i.e.,QTY2,QTY3) | O for notificationType=C2C CUSTOMER/C2C AGENT |
| "name": "PRODUCT_AMOUNT1", "value": "$12" | O There can be up 1 to 10 PRODUCT_AMOUNT(i.e.,PRODUCT_AMOUNT2,PRODUCT_AMOUNT3) | O for notificationType=C2C CUSTOMER/C2C AGENT |
| "name": "AMOUNT", "value": "$12" | O | O for notificationType=C2C CUSTOMER/C2C AGENT |
TT Market Data Model:
Note: Use on-prem url
| Field Name | M/O | Notes |
|---|---|---|
| subject | M | The subject of Notification For C2C_AGENT: It’s official! Your Flow order has been placed For C2C_CUSTOMER: Congratulations! Thank you for your order! |
| receiver.email | M | The recipients email address |
| sender.email | M | Senders email address |
| messageType | M | "Email" is in scope |
| characteristic | O | Is the array object with name value pairs. |
| "name": "EXISTING_CUSTOMER", "value": "YES" | O | O for notificationType=C2C AGENT |
| "name": "ACCOUNT_NUMBER", "value": "12345" | O | O for notificationType= C2C AGENT |
| "name": "FIRST_NAME", "value": "FNAME" | O | O for notificationType=C2C CUSTOMER/C2C AGENT |
| name": "LAST_NAME", "value": "LNAME" | O | O for notificationType=C2C CUSTOMER/C2C AGENT |
| "name": "PHONE_NUMBER", "value": "Surname" | O | O for notificationType=C2C CUSTOMER/C2C AGENT |
| "name": "EMAIL", "value": "fname.lname@gmail.com" | O | O for notificationType=C2C CUSTOMER/C2C AGENT |
| "name": "ORDER_DATE", "value": "28/08/2020" | O | O for notificationType=C2C CUSTOMER/C2C AGENT |
| "name": "LEAD_TYPE", "value": "New" | O | O for notificationType= C2C AGENT |
| "name": "PRODUCT_NAME1", "value": "SETUP BOX" | O There can be up 1 to 10 PRODUCT_NAME (i.e.,PRODUCT_NAME2,PRODUCT_NAME3) | O for notificationType=C2C CUSTOMER/C2C AGENT |
| "name": "QTY1", "value": "2" | O There can be up 1 to 10 QTY( i.e.,QTY2,QTY3) | O for notificationType=C2C CUSTOMER/C2C AGENT |
| "name": "PRODUCT_AMOUNT1", "value": "$12" | O There can be up 1 to 10 PRODUCT_AMOUNT(i.e.,PRODUCT_AMOUNT2,PRODUCT_AMOUNT3) | O for notificationType=C2C CUSTOMER/C2C AGENT |
| "name": "AMOUNT", "value": "$12" | O | O for notificationType=C2C CUSTOMER/C2C AGENT |